<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="trace-cli.html" />
<link rel="parent" href="module-trace.html" />
<link rel="next" href="python.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>25.10.2 Programming Interface</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="25.10.1 command Line Usage"
  href="trace-cli.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="25.10 trace  "
  href="module-trace.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="26. python Runtime Services"
  href="python.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="trace-cli.html">25.10.1 Command Line Usage</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-trace.html">25.10 trace  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="python.html">26. Python Runtime Services</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h2><a name="SECTION00271020000000000000000"></a><a name="trace-api"></a>
<br>
25.10.2 Programming Interface
</h2>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-5124' xml:id='l2h-5124' class="class">Trace</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>count=1</var><big>[</big><var>, trace=1</var><big>[</big><var>,
                         countfuncs=0</var><big>[</big><var>, countcallers=0</var><big>[</big><var>,
                         ignoremods=()</var><big>[</big><var>, ignoredirs=()</var><big>[</big><var>,
                         infile=None</var><big>[</big><var>, outfile=None</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Create an object to trace execution of a single statement or expression.
All parameters are optional.  <var>count</var> enables counting of line numbers.
<var>trace</var> enables line execution tracing.  <var>countfuncs</var> enables
listing of the functions called during the run.  <var>countcallers</var> enables
call relationship tracking.  <var>ignoremods</var> is a list of modules or
packages to ignore.  <var>ignoredirs</var> is a list of directories whose modules
or packages should be ignored.  <var>infile</var> is the file from which to read
stored count information.  <var>outfile</var> is a file in which to write updated
count information.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5125' xml:id='l2h-5125' class="method">run</tt></b>(</nobr></td>
  <td><var>cmd</var>)</td></tr></table></dt>
<dd>
Run <var>cmd</var> under control of the Trace object with the current tracing
parameters.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5126' xml:id='l2h-5126' class="method">runctx</tt></b>(</nobr></td>
  <td><var>cmd</var><big>[</big><var>, globals=None</var><big>[</big><var>,
                                  locals=None</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Run <var>cmd</var> under control of the Trace object with the current tracing
parameters in the defined global and local environments.  If not defined,
<var>globals</var> and <var>locals</var> default to empty dictionaries.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5127' xml:id='l2h-5127' class="method">runfunc</tt></b>(</nobr></td>
  <td><var>func, *args, **kwds</var>)</td></tr></table></dt>
<dd>
Call <var>func</var> with the given arguments under control of the
<tt class="class">Trace</tt> object with the current tracing parameters.
</dl>

<p>
This is a simple example showing the use of this module:

<p>
<div class="verbatim"><pre>
import sys
import trace

# create a Trace object, telling it what to ignore, and whether to
# do tracing or line-counting or both.
tracer = trace.Trace(
    ignoredirs=[sys.prefix, sys.exec_prefix],
    trace=0,
    count=1)

# run the new command using the given tracer
tracer.run('main()')

# make a report, placing output in /tmp
r = tracer.results()
r.write_results(show_missing=True, coverdir="/tmp")
</pre></div>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="25.10.1 command Line Usage"
  href="trace-cli.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="25.10 trace  "
  href="module-trace.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="26. python Runtime Services"
  href="python.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="trace-cli.html">25.10.1 Command Line Usage</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-trace.html">25.10 trace  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="python.html">26. Python Runtime Services</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
